Skip to content

DOCS-2693 / 28 / DOCS-2693 Fix endless refresh on drafted KMIP and Community Tutorials URLs - #4898

Merged
micjohnson777 merged 1 commit into
masterfrom
DOCS-2693-draft-alias-loop
Nov 6, 2026
Merged

micjohnson777 merged 1 commit into
masterfrom
DOCS-2693-draft-alias-loop

Conversation

@DjP-iX

@DjP-iX DjP-iX commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Problem

https://www.truenas.com/docs/scale/credentials/kmip/ refreshes forever.
Hugo still writes an alias stub for a draft page, but the stub has no target URL:

```html

```

An empty `url=` reloads the same page.
KMIP was drafted on purpose in #4663, but its aliases stayed in place, so the stub shipped.
`/scale/scaletutorials/communityrecommends/` has the same problem for the same reason.
Groups has an identical self-alias but is not a draft, so the real page replaces the stub.

Changes

  • Remove `aliases:` from the four draft pages that declare them: KMIP (`_index.md`, `ConfiguringKMIP.md`, `KMIPScreen.md`) and Community Tutorials.
  • Move those aliases to the nearest published parents so the old URLs redirect instead of 404:
    • The four KMIP URLs go to Credentials (`content/SCALE/Credentials/_index.md`).
    • The Community Tutorials URL goes to the TrueNAS landing page (`content/SCALE/_index.md`).
    • Each block has a comment to move the aliases back when the pages leave draft.
  • `.github/scripts/check_aliases.py` now fails when a changed content file has `draft: true` and declares aliases.

… when drafts declare aliases

Hugo writes an alias stub for a draft page with an empty target
(<meta http-equiv=refresh content="0; url=">), which reloads itself
forever. /scale/credentials/kmip/ and /scale/scaletutorials/communityrecommends/
served that stub.

Remove aliases from the draft KMIP and Community Tutorials pages and move
them to the nearest published parents (Credentials, TrueNAS landing page) so
old URLs redirect instead of 404. Add a CI check that fails when a draft page
declares aliases.
@DjP-iX
DjP-iX requested a review from a team as a code owner November 5, 2026 20:13
@bugclerk

bugclerk commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Nov 5, 2026

Copy link
Copy Markdown

Vale Style Guide Issues

📊 Summary: 33 issues found in changed files - 4 errors, 0 warnings, 29 suggestions

Changed files with issues:

content/SCALE/Credentials/KMIP/KMIPScreen.md (15 issues)

  • Line 14 - suggestion: Keep sentences under 30 words
  • Lines 14, 36, 37 - suggestion: Use active voice instead of passive voice
  • Line 33 - error: Use 'hostname' instead of 'host name'

content/SCALE/Credentials/KMIP/ConfiguringKMIP.md (8 issues)

  • Lines 24, 58 - suggestion: Keep sentences under 30 words
  • Line 26 - suggestion: Use active voice instead of passive voice
  • Line 43 - error: Use 'login' instead of 'Log in'
  • Line 50 - suggestion: Avoid using first-person plural (we, us, our)
  • Line 58 - error: Use 'hostname' instead of 'host name'

content/SCALE/Credentials/_index.md (7 issues)

  • Lines 18, 37 - suggestion: Use active voice instead of passive voice
  • Line 30 - suggestion: Use 'backup' instead of 'back up'
  • Line 37 - error: Use 'login' instead of 'log in'
  • Line 37 - suggestion: Use 'login' instead of 'log in'

content/SCALE/CommunityRecommends/_index.md (2 issues)

  • Line 11 - suggestion: Use active voice instead of passive voice

content/SCALE/_index.md (1 issues)

  • Line 48 - suggestion: Spell out 'CORE' on first use

🔧 To fix: Review the issues above and update your documentation accordingly.

@micjohnson777
micjohnson777 merged commit a991daf into master Nov 6, 2026
4 checks passed
@micjohnson777
micjohnson777 deleted the DOCS-2693-draft-alias-loop branch November 6, 2026 12:39
@bugclerk

bugclerk commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

@truenas truenas locked as resolved and limited conversation to collaborators Nov 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants